ソフトバンクまとめて支払い

ソフトバンクまとめて支払い(随時決済) 決済 API一覧

※idPass版にのみ対応しています。json版には対応しておりません。

HTTP仕様（.idPass）

Request header
Content-Type: application/x-www-form-urlencoded;charset=windows-31j
Method
POST
Response header
Content-Type: text/plain;charset=windows-31j
Status Code
200：常に200を返却

EntryTranSb 取引登録

これ以降の決済取引で必要となる取引IDと取引パスワードの発行を行い、取引を開始します。

リクエスト
ShopID 必須 半角英数13桁 固定
ショップID

ShopPass 必須 半角英数64桁
ショップパスワード

OrderID 必須 半角英数記号27桁
オーダーID

JobCd 必須
処理区分

AUTH：仮売上
CAPTURE：即時売上

Amount 必須 半角数字5桁
利用金額

Tax 半角数字5桁
税送料

PaymentType 必須 半角数字1桁
決済タイプ

1：随時決済
※随時決済を行う場合、必須です。

URL
/payment/EntryTranSb.idPass
リクエストパラメータ
ShopID=tshop11223344&ShopPass=PASSWORD&OrderID=ORDER0000001&JobCd=AUTH&Amount=1000&PaymentType=1
レスポンス
正常
AccessID 半角英数32桁 固定
取引ID

AccessPass 半角英数32桁 固定
取引パスワード

異常
ErrCode 半角英数3桁 固定
エラーコード
ErrInfo 半角英数9桁 固定
エラー詳細コード
レスポンスパラメータ：正常系
AccessID=a6a6b0061347e90cdef806b39bd28705&AccessPass=5e0e54b892e14ed03e8cf807a6053813
レスポンスパラメータ：異常系
ErrCode=E01&ErrInfo=E01040001

ExecTranSb 決済実行

決済処理を行い結果を返却します。

リクエスト
ShopID 必須 半角英数13桁 固定
ショップID

ShopPass 必須 半角英数64桁
ショップパスワード

AccessID 必須 半角英数32桁 固定
取引ID

AccessPass 必須 半角英数32桁 固定
取引パスワード

OrderID 必須 半角英数記号27桁
オーダーID

ClientField1 全半角100バイト
加盟店自由項目1

ClientField2 全半角100バイト
加盟店自由項目2

ClientField3 全半角100バイト
加盟店自由項目3

ItemName 全半角40桁
商品名

ソフトバンクのご利用履歴に表示されます。

※使用可能文字は以下となります。
・半角英数字
・半角記号（* アスタリスク - ハイフン _ アンダーバー @ アットマーク . ピリオド 半角スペース）
・全角文字（JIS 第一水準漢字、JIS 第二水準漢字）
上記以外を指定した場合は、ソフトバンク側でエラーとなります。
※機種依存文字は使用できません。
※以下8文字は例外で使用できません。
― ダッシュ(01 区 2130 ＋D)
＼ バックスラッシュ(01 区 2140 ＋0)
～ 波ダッシュ(01 区 2140 ＋1)
‖ パラレル(01 区 2140 ＋2)
－ 二分ダッシュ(01 区 2150 ＋D)
¢ セント(01 区 2170 ＋1)
£ ポンド(01 区 2170 ＋2)
¬ 否定算術記号(02 区 2240 ＋C)

※マルチバイト文字は2バイト扱いとなります。
※半角カナは全角に変換されます。
※40バイトを超える場合は切り捨てられて表示されます。
※弊社システム上は40文字まで指定可能です。
※指定しない場合はショップ名が適用されます。

SbAcceptCode 必須 半角英数14桁
SB承諾番号

URL
/payment/ExecTranSb.idPass
リクエストパラメータ
ShopID=tshop11223344&ShopPass=PASSWORD&AccessID=a6a6b0061347e90cdef806b39bd28705&AccessPass=5e0e54b892e14ed03e8cf807a6053813&OrderID=ORDER0000001&SbAcceptCode=12345678901234
レスポンス
正常
OrderID 半角英数記号27桁
オーダーID

Status
現状態

該当取引の取引状態を返却します。
AUTH：仮売上
CAPTURE：即時売上

TranDate 半角数字14桁 固定
処理日時

当サービスで処理を実施した日時を返却します。
yyyyMMddHHmmss書式

SbTrackingId 半角英数14桁
ソフトバンク処理トラッキングID
CheckString 半角英数32桁
改ざんチェック文字列

OrderID,AccessID,ShopID,ShopPassを連結しMD5ハッシュした値を返却します。

異常
ErrCode 半角英数3桁 固定
エラーコード
ErrInfo 半角英数9桁 固定
エラー詳細コード
レスポンスパラメータ：正常系
OrderID=ORDER0000001&Status=AUTH&TranDate=20220722112429&SbTrackingId=12345678901234&CheckString=207c44550ac7f47cbc6dbef22c4c27fd
レスポンスパラメータ：異常系
ErrCode=E01&ErrInfo=E01040001

SbCancel キャンセル

決済が完了した取引に対して決済内容のキャンセルを行います。

リクエスト
ShopID 必須 半角英数13桁 固定
ショップID

ShopPass 必須 半角英数64桁
ショップパスワード

AccessID 必須 半角英数32桁 固定
取引ID

AccessPass 必須 半角英数32桁 固定
取引パスワード

OrderID 必須 半角英数記号27桁
オーダーID

CancelAmount 必須 半角数字6桁
キャンセル金額
CancelTax 半角数字5桁
キャンセル税送料

URL
/payment/SbCancel.idPass
リクエストパラメータ
ShopID=tshop11223344&ShopPass=PASSWORD&AccessID=a6a6b0061347e90cdef806b39bd28705&AccessPass=5e0e54b892e14ed03e8cf807a6053813&OrderID=ORDER0000001&CancelAmount=1000
レスポンス
正常
OrderID 半角英数記号27桁
オーダーID

Status
現状態

キャンセル成功時は以下のステータスが返却されます。
・CANCEL：キャンセル

キャンセル失敗時はキャンセル処理前のステータスが返却されます。

CancelAmount 半角数字6桁
キャンセル金額
CancelTax 半角数字5桁
キャンセル税送料
異常
ErrCode 半角英数3桁 固定
エラーコード
ErrInfo 半角英数9桁 固定
エラー詳細コード
レスポンスパラメータ：正常系
OrderID=ORDER0000001&Status=CANCEL&CancelAmount=1000&CancelTax=0
レスポンスパラメータ：異常系
ErrCode=E01&ErrInfo=E01040001

SbSales 実売上

仮売上の決済に対して実売上を行います。尚、実行時に仮売上時との金額チェックを行います。

リクエスト
ShopID 必須 半角英数13桁 固定
ショップID

ShopPass 必須 半角英数64桁
ショップパスワード

AccessID 必須 半角英数32桁 固定
取引ID

AccessPass 必須 半角英数32桁 固定
取引パスワード

OrderID 必須 半角英数記号27桁
オーダーID

Amount 必須 半角数字6桁
利用金額

Tax 半角数字5桁
税送料

URL
/payment/SbSales.idPass
リクエストパラメータ
ShopID=tshop11223344&ShopPass=PASSWORD&AccessID=a6a6b0061347e90cdef806b39bd28705&AccessPass=5e0e54b892e14ed03e8cf807a6053813&OrderID=ORDER0000001&Amount=1000
レスポンス
正常
OrderID 半角英数記号27桁
オーダーID

Status
現状態

実売上成功時は以下のステータスが返却されます。
・SALES：実売上

Amount 半角数字6桁
利用金額

Tax 半角数字5桁
税送料

異常
ErrCode 半角英数3桁 固定
エラーコード
ErrInfo 半角英数9桁 固定
エラー詳細コード
レスポンスパラメータ：正常系
OrderID=ORDER0000001&Status=SALES&Amount=1000&Tax=0
レスポンスパラメータ：異常系
ErrCode=E01&ErrInfo=E01040001